CFileSys Class

The CFileSys class wraps the Microsoft File System Object and provides methods to work with files and folders, giving your application the ability to create, copy, alter, move, and delete files and folders, or to determine if and where particular files or folders exist. It also enables you to get information about files and folders, such as their names and the date they were created or last modified.

Include file: CFileSys.inc

Methods

BuildPath

Appends a name to an existing path.

FUNCTION BuildPath (BYREF cbsPath AS CBSTR, BYREF cbsName AS CBSTR) AS CWSTR

Return value

CBSTR. The new path.

Remarks

The BuildPath method inserts an additional path separator between the existing path and the name, only if necessary.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cbsNewPath AS CBSTR = pFileSys.BuildPath ("C:\MyFolder", "Text.txt")

CopyFile

Copies one or more files from one location to another.

FUNCTION CopyFile (BYREF cbsSource AS CBSTR, BYREF cbsDestination AS CBSTR, _
   BYVAL OverWriteFiles AS VARIANT_BOOL = -1) AS HRESULT

Return value

HRESULT. S_OK (0) on success, or an error code on failure.

Remarks

Wildcard characters can only be used in the last path component of the cbSource argument.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
pFileSys.CopyFile("C:\MyFolder\MyFile.txt", "C:\MyOtherFolder\MyFile.txt")

CopyFolder

Recursively copies a folder from one location to another.

FUNCTION CopyFolder (BYREF cbsSource AS CBSTR, BYREF cbsDestination AS CBSTR, _
   BYVAL OverWriteFiles AS VARIANT_BOOL = -1) AS HRESULT

Return value

HRESULT. S_OK (0) on success, or an error code on failure.

Remarks

Wildcard characters can only be used in the last path component of the cbSource argument.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
pFileSys.CopyFolder("C:\MyFolder", "C:\MyOtherFolder\")

CreateFolder

Creates a folder.

FUNCTION CreateFolder (BYREF cbsFolderSpec AS CBSTR) AS Afx_IFolder PTR

Return value

IDispatch. Reference to an IFolder object.

Remarks

An error occurs if the specified folder already exists.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM pFolder AS Afx_Folder PTR
pFolder = pFileSys.CreateFolder("C:\MyNewFolder")
IF pFolder THEN
   ' ....
   pFolder.Release
END IF

DeleteFile

Deletes a specified file.

FUNCTION DeleteFile (BYREF cbsFileSpec AS CBSTR, BYVAL bForce AS VARIANT_BOOL = FALSE) AS HRESULT

Return value

HRESULT. S_OK (0) on success, or an error code on failure.

Remarks

An error occurs if no matching files are found. The DeleteFile method stops on the first error it encounters. No attempt is made to roll back or undo any changes that were made before an error occurred.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
pFileSys.DeleteFile("C:\MyFolder\MyFile.txt")

DeleteFolder

Deletes a specified folder and its contents.

FUNCTION DeleteFolder (BYREF cbsFolderSpec AS CBSTR, BYVAL bForce AS VARIANT_BOOL = FALSE) AS HRESULT

Return value

HRESULT. S_OK (0) on success, or an error code on failure.

Remarks

The DeleteFolder method does not distinguish between folders that have contents and those that do not. The specified folder is deleted regardless of whether or not it has contents.

An error occurs if no matching folders are found. The DeleteFolder method stops on the first error it encounters. No attempt is made to roll back or undo any changes that were made before an error occurred.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
pFileSys.DeleteFolder("C:\MyFolder")

DriveExists

Returns True if the specified drive exists; False if it does not.

FUNCTION DriveExists (BYREF cbsDriveSpec AS CBSTR) AS BOOLEAN

Return value

BOOLEAN. True if the specified drive exists; False if it does not.

Remarks

For drives with removable media, the DriveExists method returns true even if there are no media present. Use the IsDriveReady method to determine if a drive is ready.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM fExists AS BOOLEAN = pFileSys.DriveExists("C:")

DriveLetters

Returns a semicolon separated list with the driver letters.

FUNCTION DriveLetters () AS CBSTR

Return value

CBSTR. A semicolon separated list with the driver letters.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cbsLetters AS CBSTR = pFileSys.DriveLetters

FileExists

Returns True if the specified file exists; False if it does not.

FUNCTION FileExists (BYREF cbsFileSpec AS CBSTR) AS BOOLEAN

Return value

Boolean. True if the specified file exists; False if it does not.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM fExists AS BOOLEAN = pFileSys.FileExists("C:\MyFolder\Test.txt")

FolderExists

Returns True if the specified folder exists; False if it does not.

FUNCTION FolderExists (BYREF cbsFolderSpec AS CBSTR) AS BOOLEAN

Return value

Boolean. True if the specified folder exists; False if it does not.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM fExists AS BOOLEAN = pFileSys.FolderExists("C:\MyFolder")

GetAbsolutePathName

Returns complete and unambiguous path from a provided path specification.

FUNCTION GetAbsolutePathName (BYREF cbsPathSpec AS CBSTR) AS CBSTR

Return value

Boolean. The path name.

Remarks

A path is complete and unambiguous if it provides a complete reference from the root of the specified drive. A complete path can only end with a path separator character () if it specifies the root folder of a mapped drive.

Assuming the current directory is c:\mydocuments\reports, the following table illustrates the behavior of the GetAbsolutePathName method.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cbsName AS CBSTR = pFileSys.GetAbsolutePathName("C:\MyFolder\Test.txt")

GetBaseName

Returns a string containing the base name of the last component, less any file extension, in a path

FUNCTION GetBaseName (BYREF cbsPathSpec AS CBSTR) AS CBSTR

Return value

Boolean. The base name.

Remarks

The GetBaseName method returns a zero-length string ("") if no component matches the path argument. The GetBaseName method works only on the provided path string. It does not attempt to resolve the path, nor does it check for the existence of the specified path.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cwsName AS CWSTR = pFileSys.GetBaseName("C:\MyFolder\Test.txt")

GetDriveAvailableSpace

Returns the amount of space available to a user on the specified drive or network share.

FUNCTION GetDriveAvailableSpace (BYREF cbsDrive AS CBSTR) AS DOUBLE

Return value

DOUBLE. The amount of available space.

Remarks

The value returned by the GetDriveAvailableSpace method is typically the same as that returned by the GetDriveFreeSpace method. Differences may occur between the two for computer systems that support quotas.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
PRINT pFileSys.GetDriveAvailableSpace("C:")

GetDriveFileSystem

Returns the type of file system in use for the specified drive or network share.

FUNCTION GetDriveFileSystem (BYREF cbsDrive AS CBSTR) AS CBSTR

Return value

CBSTR. The type of file system in use.

Remarks

Available return types include FAT, NTFS, and CDFS.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cbsFileSystem AS CBSTR = pFileSys.GetDriveFileSystem("C:")

GetDriveFreeSpace

Returns the amount of free space available to a user on the specified drive or network share

FUNCTION GetDriveFreeSpace (BYREF cbsDrive AS CBSTR) AS DOUBLE

Return value

DOUBLE. The amount of free space.

Remarks

The value returned by the GetDriveFreeSpace property is typically the same as that returned by the GetDriveAvailableSpace property. Differences may occur between the two for computer systems that support quotas.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
PRINT pFileSys.GetDriveFreeSpace("C:")

GetDriveName

Returns a string containing the name of the drive for a specified path.

FUNCTION GetDriveName (BYREF cbsPathSpec AS CBSTR) AS CBSTR

Return value

CBSTR. The drive name.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cbsName AS CBSTR = pFileSys.GetDriveName("C:\MyFolder\Test.txt")

GetDriveShareName

Returns the network share name for a specified drive.

FUNCTION GetDriveShareName (BYREF cbsDrive AS CBSTR) AS CBSTR

Return value

CBSTR. The share name.

Remarks

If object is not a network drive, the GetDriveShareName method returns a zero-length string ("").

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cbsShareName AS CBSTR = pFileSys.GetDriveShareName("H:")

GetDriveTotalSize

Returns the total space, in bytes, of a drive or network share.

FUNCTION GetDriveTotalSize (BYREF cbsDrive AS CBSTR) AS DOUBLE

Return value

DOUBLE. The total space in bytes.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
PRINT pFileSys.GetDriveTotalSize("C:")

GetDriveType

Returns a value indicating the type of a specified drive.

FUNCTION GetDriveType (BYREF cbsDrive AS CBSTR) AS DRIVETYPECONST

Return value

The type of the specified drive.

DriveType_UnknownType = 0
DriveType_Removable = 1
DriveType_Fixed = 2
DriveType_Remote = 3
DriveType_CDRom = 4
DriveType_RamDisk = 5

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM nDriveType AS DRIVETYPECONST = pFileSys.GetDriveType("C:")
DIM t AS CBSTR
SELECT CASE pDrive.DriveType
   CASE 0 : t = "Unknown"
   CASE 1 : t = "Removable"
   CASE 2 : t = "Fixed"
   CASE 3 : t = "Network"
   CASE 4 : t = "CD-ROM"
   CASE 5 : t = "RAM Disk"
END SELECT

GetExtensionName

Returns a string containing the extension name of the file for a specified path.

FUNCTION GetExtensionName (BYREF cbsPathSpec AS CBSTR) AS CBSTR

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cbsName AS CBSTR = pFileSys.GetExtensionName("C:\MyFolder\Test.txt")

GetFileAttributes

Returns the attributes of files.

FUNCTION GetFileAttributes (BYREF cbsFile AS CBSTR) AS FILEATTRIBUTE

Return value

The file attributes. Can be any of the following values or any logical combination of the following values:

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM lAttr FILEATTRIBUTE = pFileSys.GetFileAttributes("C:\MyPath\MyFile.txt")

GetFileDateCreated

Returns the date and time that the specified file was created.

FUNCTION GetFileDateCreated (BYREF cbsFile AS CBSTR) AS DATE_

Return value

DATE_. The date and time of the file creation. This is a Date Serial number that can be formatted using the Free Basic's Format function. You can also use the wrapper function AfxVariantDateTimeToStr.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM nDate AS DATE_ = pFileSys.GetFileDateCreated("C:\MyPath\MyFile.txt")

GetFileDateLastAccessed

Returns the date and time that the specified file was accesed.

FUNCTION GetFileDateLastAccessed (BYREF cbsFile AS CBSTR) AS DATE_

Return value

DATE_. The date and time that the file was last accessed. This is a Date Serial number that can be formatted using the Free Basic's Format function. You can also use the wrapper function AfxVariantDateTimeToStr.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM nDate AS DATE_ = pFileSys.GetFileDateLastAccessed("C:\MyPath\MyFile.txt")

GetFileDateLastModified

Returns the date and time that the specified file was accessed.

FUNCTION GetFileDateLastModified (BYREF cbsFile AS CBSTR) AS DATE_

Return value

DATE_. The date and time that the file was last modified. This is a Date Serial number that can be formatted using the Free Basic's Format function. You can also use the wrapper function AfxVariantDateTimeToStr.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM nDate AS DATE_ = pFileSys.GetFileDateLastModified("C:\MyPath\MyFile.txt")

GetFileName

Returns a string containing the name of the file for a specified path.

FUNCTION GetFileName (BYREF cbsPathSpec AS CBSTR) AS CBSTR

Return value

CBSTR. The file name.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cbsName AS CBSTR = pFileSys.GetFileName("C:\MyFolder\Test.txt")

GetFileShortName

Returns the short name used by programs that require the earlier 8.3 file naming convention.

FUNCTION GetFileShortName (BYREF cbsPathSpec AS CBSTR) AS CBSTR

Return value

CBSTR. The short name for the specified file.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cbsName AS CBSTR = pFileSys.GetFileShortName("C:\MyFolder\Test.txt")

GetFileShortPath

Returns the short path used by programs that require the earlier 8.3 file naming convention.

FUNCTION GetFileShortPath (BYREF cbsPathSpec AS CBSTR) AS CBSTR

Return value

CBSTR. The short path to a specific file.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cbsName AS CBSTR = pFileSys.GetFileShortPath("C:\MyFolder\Test.txt")

GetFileSize

Returns the size, in bytes, of the specified file.

FUNCTION GetFileSize (BYREF cbsFile AS CBSTR) AS LONG

Return value

LONG. The size, in bytes, of the file.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM nFileSize AS LONG = pFileSys.GetFileSize("C:\MyPath\MyFile.txt")

GetFileType

Returns information about the type of a file. For example, for files ending in .TXT, "Text Document" is returned.

FUNCTION GetFileType (BYREF cbsFile AS CBSTR) AS CBSTR

Return value

CBSTR. The type of file.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cbsFileType AS CBSTR = pFileSys.GetFileType("C:\MyPath\MyFile.txt")

GetFileVersion

Returns the version number of a specified file.

FUNCTION GetFileVersion (BYREF cbsFile AS CBSTR) AS CBSTR

Return value

CBSTR. The version number.

Remarks

The GetFileVersion method returns a zero-length string ("") if cbsFile does not end with the named component.

Note: The GetFileVersion method works only on the provided path string. It does not attempt to resolve the path, nor does it check for the existence of the specified path.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cbsVersion AS CBSTR = pFileSys.GetFileVersion("C:\MyFolder\MyFile.doc")
IF LEN(cbsVersion) THEN
   MSGBOX "File version: " & cbsVersion
ELSE
   MSGBOX "No version information available"
END IF

DIM pFileSys AS CFileSys
print pFileSys.GetFileVersion("c:\windows\system32\scrrun.dll")

GetFolderAttributes

Returns the attributes of folders.

FUNCTION GetFolderAttributes (BYREF cbsFolder AS CBSTR) AS FILEATTRIBUTE

Return value

The attributes. Can be any of the following values or any logical combination of the following values:

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM lAttr FILEATTRIBUTE = pFileSys.GetFolderAttributes("C:\MyPath")

GetFolderDateCreated

Returns the date and time that the specified folder was created.

FUNCTION GetFolderDateCreated (BYREF cbsFolder AS CBSTR) AS DATE_

Return value

DATE_. The date and time that the folder was created. This is a Date Serial number that can be formatted using the Free Basic's Format function. You can also use the wrapper function AfxVariantDateTimeToStr.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM nDate AS DATE_ = pFileSys.GetFolderDateCreated("C:\MyPath")

GetFolderDateLastAccessed

Returns the date and time that the specified folder was last accessed.

FUNCTION GetFolderDateLastAccessed (BYREF cbsFolder AS CBSTR) AS DATE_

Return value

DATE_. The date and time that the folder was last accessed. This is a Date Serial number that can be formatted using the Free Basic's Format function. You can also use the wrapper function AfxVariantDateTimeToStr.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM nDate AS DATE_ = pFileSys.GetFolderDateLastAccessed("C:\MyPath)

GetFolderDateLastModified

Returns the date and time that the specified folder was last modified.

FUNCTION GetFolderDateLastModified (BYREF cbsFolder AS CBSTR) AS DATE_

Return value

DATE_. The date and time that the folder was last modified. This is a Date Serial number that can be formatted using the Free Basic's Format function. You can also use the wrapper function AfxVariantDateTimeToStr.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM nDate AS DATE_ = pFileSys.GetFolderDateLastModified("C:\MyPath)

GetFolderDriveLetter

Returns a string containing the drive letter for a specified folder.

FUNCTION GetFolderDriveLetter (BYREF cbsFolder AS CBSTR) AS CBSTR

Return value

CBSTR. The drive letter of the folder.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cbsDriveLetter AS CBSTR = pFileSys.GetFolderDriveLetter("c:\MyFolder)

GetFolderName

Returns a string containing the name of the folder for a specified path, i.e. the path minus the file name.

FUNCTION GetFolderName (BYREF cbsPathSpec AS CBSTR) AS CBSTR

Return value

CBSTR. The name of the folder.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cbsName AS CBSTR = pFileSys.GetFolderName("C:\MyFolder\Test.txt")

GetFolderShortName

Returns the short name used by programs that require the earlier 8.3 file naming convention.

FUNCTION GetFolderShortName (BYREF cbsPathSpec AS CBSTR) AS CBSTR

Return value

CBSTR. The short name for the specified folder.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cbsFolderShortPath AS CBSTR = pFileSys.GetFolderShortName("c:\MyFolder)

GetFolderShortPath

Returns the short path used by programs that require the earlier 8.3 file naming convention.

FUNCTION GetFolderShortPath (BYREF cbsPathSpec AS CBSTR) AS CBSTR

Return value

CBSTR. The short path for the specified folder.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cbsFolderShortPath AS CBSTR = pFileSys.GetFolderShortPath("c:\MyFolder)

GetFolderSize

Returns the size, in bytes, of all files and subfolders contained in the folder.

FUNCTION GetFolderSize (BYREF cbsFolder AS CBSTR) AS LONG

Return value

LONG. The size, in bytes, of all files and subfolders contained in the folder.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM nFolderSize AS LONG = pFileSys.GetFolderSize("C:\MyPath")

GetFolderType

Returns information about the type of a folder.

FUNCTION GetFolderType (BYREF cbsFolder AS CBSTR) AS CBSTR

Return value

CBSTR. The type of folder.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cbsFolderType AS CBSTR = pFileSys.GetFolderType("c:\MyFolder)

GetLastResult

Returns the last result code.

FUNCTION GetLastResult () AS HRESULT

Return value

HRESULT. The result code returned by the last executed method.

GetNumDrives

Returns the number of drives.

FUNCTION GetNumDrives () AS LONG

Return value

LONG. The number of drives.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM numDrives AS LONG = pFileSys.GetNumDrives

GetNumFiles

Returns the number of files contained in a specified folder, including those with hidden and system file attributes set.

FUNCTION GetNumFiles (BYREF cbsFolder AS CBSTR) AS LONG

Return value

LONG. The number of files.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM numFiles AS LONG = pFileSys.GetNumFiles("C:\MyFolder")

GetNumSubFolders

Returns the number of files contained in a specified folder, including those with hidden and system file attributes set.

FUNCTION GetNumSubFolders (BYREF cbsFolder AS CBSTR) AS LONG

Return value

LONG. The number of subfolders.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM numSubFolders AS LONG = pFileSys.GetNumSubFolders("C:\MyFolder")

GetParentFolderName

Returns the folder name for the parent of the specified folder.

FUNCTION GetParentFolderName (BYREF cbsFolder AS CBSTR) AS CBSTR

Return value

CBSTR. The name of the parent folder, or a empty string if the folder has no parent.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cbsParentFolderName AS CBSTR = pFileSys.GetParentFolderName("C:\MyFolder\MySubfolder")

GetSerialNumber

Returns the decimal serial number used to uniquely identify a disk volume.

FUNCTION GetSerialNumber (BYREF cbsDrive AS CBSTR) AS LONG

Return value

LONG. The serial number.

Remarks

You can use the GetSerialNumber method to ensure that the correct disk is inserted in a drive with removable media.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM nSerialNumber AS LONG = pFileSys.GetSerialNumber("C:")

GetStandardStream

Returns a TextStream object corresponding to the standard input, output, or error stream.

FUNCTION GetStandardStream (BYVAL nStreamType AS STANDARDSTREAMTYPES, _
   BYVAL bUnicode AS VARIANT_BOOL = FALSE) AS Afx_ITextStream PTR

Return value

A pointer to the ITextStream interface of the requested standard stream.

Settings

The nStreamType argument can have any of the following settings:

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM pStm AS Afx_ITextStream PTR = pFileSys.GetStandardStream(StandardStreamTypes_StdOut)

GetStdErrStream

Returns a TextStream object corresponding to the standard error stream.

FUNCTION GetStdErrStream (BYVAL bUnicode AS VARIANT_BOOL = FALSE) AS Afx_ITextStream PTR

Return value

A pointer to the ITextStream interface of the standard error stream.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM pStm AS Afx_ITextStream PTR = pFileSys.GetStdErrStream

GetStdInStream

Returns a TextStream object corresponding to the standard input stream.

FUNCTION GetStdInStream (BYVAL bUnicode AS VARIANT_BOOL = FALSE) AS Afx_ITextStream PTR

Return value

A pointer to the ITextStream interface of the standard input stream.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM pStm AS Afx_ITextStream PTR = pFileSys.GetStdInStream

GetStdOutStream

Returns a TextStream object corresponding to the standard output stream.

FUNCTION GetStdOutStream (BYVAL bUnicode AS VARIANT_BOOL = FALSE) AS Afx_ITextStream PTR

Return value

A pointer to the ITextStream interface of the standard output stream.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM pStm AS Afx_ITextStream PTR = pFileSys.GetStdOutStream

GetTempName

Returns a randomly generated temporary file or folder name that is useful for performing operations that require a temporary file or folder.

FUNCTION GetTempName () AS CBSTR

Return value

CBSTR. The temporary name.

Remarks

The GetTempName method does not create a file. It provides only a temporary file name that can be used with CreateTextFile to create a file.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cbsName AS CBSTR = pFileSys.GetTempName

GetVolumeName

Returns the volume name of the specified drive.

FUNCTION GetVolumeName (BYREF cbsDrive AS CBSTR) AS CBSTR

Return value

CBSTR. The volume name.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM cbsVolumeName AS CBSTR = pFileSys.GetVolumeName("C:")

IsDriveReady

Returns True if the specified drive is ready; False if it is not.

FUNCTION IsDriveReady (BYREF cbsDrive AS CBSTR) AS BOOLEAN

Return value

BOOLEAN. True if the specified drive is ready; False if it is not.

Remarks

For removable-media drives and CD-ROM drives, IsDriveReady returns True only when the appropriate media is inserted and ready for access.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM bIsReady AS BOOLEAN = pFileSys.IsDriveReady("C:")

IsRootFolder

Returns True(-1) if the specified folder is the root folder; False(0) if it is not.

FUNCTION IsRootFolder (BYREF cbsFolder AS CBSTR) AS BOOLEAN

Return value

BOOLEAN. True(-1) if the specified folder is the root folder; False(0) if it is not.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
DIM bIsRoot AS BOOLEAN = pFileSys.IsRootFolder("C:\MyFolder")

MoveFile

Moves one or more files from one location to another.

FUNCTION MoveFile (BYREF cbsSource AS CBSTR, BYREF cbsDestination AS CBSTR) AS HRESULT

Return value

HRESULT. S_OK (0) on success, or an error code on failure.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
pFileSys.MoveFile("C:\MyFolder\MyFile.txt", "C:\MyOtherFolder\")

MoveFolder

Moves one or more folders from one location to another.

FUNCTION MoveFolder (BYREF cbsSource AS CBSTR, BYREF cbsDestination AS CBSTR) AS HRESULT

Return value

HRESULT. S_OK (0) on success, or an error code on failure.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
pFileSys.MoveFolder("C:\MyFolder", "C:\MyNewFolder\")

SetFileAttributes

Sets the attributes of files.

FUNCTION SetFileAttributes (BYREF cbsFile AS CBSTR, BYVAL lAttr AS FILEATTRIBUTE) AS HRESULT

Return value

The file attributes. Can be any of the following values or any logical combination of the following values:

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
pFileSys.SetFileAttributes("C:\MyPath\MyFile.txt", 33)   ' FileAttribute_Archive OR FileAttribute_Normal

SetFileName

Sets the name of a specified file.

FUNCTION SetFileName (BYREF cbsFile AS CBSTR, BYREF cbsName AS CBSTR) AS HRESULT

Return value

HRESULT. S_OK (0) on success, or an error code on failure.

Remarks

You only have to pass the new name of the file, not the full path.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
pFileSys.SetFileName("c:\MyFolder\Test.txt", "NewName")

SetFolderAttributes

Sets the attributes of folders.

FUNCTION SetFolderAttributes (BYREF cbsFolder AS CBSTR, BYVAL lAttr AS FILEATTRIBUTE) AS HRESULT

Return value

The lAttr argument can have any of the following values or any logical combination of the following values:

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
pFileSys.SetFolderAttributes("C:\MyPath\MyFile.txt", 17)   ' FileAttribute_Directory OR FileAttribute_ReadOnly

SetFolderName

Sets the name of a specified folder.

FUNCTION SetFolderName (BYREF cbsFolder AS CBSTR, BYREF cbsName AS CBSTR) AS HRESULT

Return value

HRESULT. S_OK (0) on success, or an error code on failure.

Remarks

You only have to pass the new name of the folder, not the full path.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
pFileSys.SetFolderName("c:\MyFolder", "NewName")

SetVolumeName

Sets the name of a specified drive.

FUNCTION SetVolumeName (BYREF cbsDrive AS CBSTR, BYREF cbsName AS CBSTR) AS HRESULT

Return value

HRESULT. S_OK (0) on success, or an error code on failure.

Usage example

#INCLUDE ONCE "Afx/CFileSys.inc"
DIM pFileSys AS CFileSys
pFileSys.SetVolumeName("C:", "VolumeName")